/**
 *  EKology - An Ecosystem Simulation Framework
 *  Copyright (C) 2008  Aarón Tavío - aaron.tavio at gmail.com - ULPGC
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 * 
 */

package net.ekology.ekosystem;

import java.util.Calendar;
import net.ekology.ekosystem.datatypes.Genome;


/**
 * Every biotic agent in the ecosystem must extend this class
 * <p>
 * A <code>BioticAgent</code> must have a genome.
 * 
 * @author Aarón Tavío - aaron.tavio at gmail.com
 * @version 1.0.0 - 20081019-1700
 */
public abstract class BioticAgent extends Agent {
    private Genome oGenome;
    
    
    public BioticAgent() {
        super();
        oGenome = null;
    }
    
    public BioticAgent(String sID, Biotope oBiotope, Genome oGenome) {
        super(sID,oBiotope);
        this.oGenome = null;
        setGenome(oGenome);
    }
    
    public BioticAgent(String sID, Biotope oBiotope, Genome oGenome, Calendar oCreationDate) {
        super(sID,oBiotope,oCreationDate);
        this.oGenome = null;
        setGenome(oGenome);
    }
    
    
    public Genome getGenome() {
        return oGenome.clone();
    }
    
    
    public void setGenome(Genome oGenome) {
        if (this.oGenome == null) {
            this.oGenome = oGenome.clone();
            this.oGenome.setID(getID());
            initializeFeatures();
        }
    }
    
    
    /**
     * Used to obtain the features from the <code>Genome</code>
     * <p>
     * This method is invoked right after the genome is set
     */
    protected abstract void initializeFeatures();
}
